Skip to content

Structured flowsheet wrapper util #1702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
dangunter wants to merge 88 commits into
base: main
Choose a base branch
from
Open

Structured flowsheet wrapper util #1702

dangunter wants to merge 88 commits into from

Conversation

@dangunter
Copy link
Member

@dangunter dangunter commented Nov 13, 2025 •
edited
Loading

Fixes #1701

Summary/Motivation:

Need additional flowsheet structure to incorporate into Jupyter UI plans

Changes proposed in this PR:

  • utility code to wrap a flowsheet, in runner and fsrunner modules
  • log utility for removing spurious output (useful for UIs), in logutil
  • action for timing, in runner_actions module
  • example wrapped flowsheet (IDAES modules only)
  • tests to desired coverage level
  • documentation

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@dangunter dangunter self-assigned this Nov 13, 2025
@dangunter dangunter marked this pull request as draft November 13, 2025 14:47
@dangunter dangunter added the enhancement New feature or request label Nov 13, 2025
@ksbeattie ksbeattie added the Priority:Normal Normal Priority Issue or PR label Nov 13, 2025
@codecov
Copy link

codecov bot commented Nov 17, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 92.38411% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 77.50%. Comparing base (36e6eb8) to head (5aa7b0e).
⚠️ Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
idaes/core/util/structfs/runner_actions.py 86.66% 7 Missing and 9 partials ⚠️
idaes/core/util/structfs/runner.py 94.44% 4 Missing and 3 partials ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1702      +/-   ##
==========================================
+ Coverage   77.46%   77.50%   +0.03%     
==========================================
  Files         395      399       +4     
  Lines       64763    65094     +331     
  Branches    10897    10947      +50     
==========================================
+ Hits        50171    50452     +281     
- Misses      12084    12116      +32     
- Partials     2508     2526      +18

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

dangunter and others added 29 commits January 22, 2026 14:10
@dangunter
cleanup of ModelVariables
e5b416f
@dangunter
put structfs into docs
c60e736
@dangunter
install pandoc for docs
3157ae2
@dangunter
make sure to use conda-forge
d6fe49b
@dangunter
unused var
7e22f73
@dangunter
tweak
df1fcc3
@dangunter
fixed pylint warnings
bdc8893
@dangunter
fixed pylint warnings
603c81c
@dangunter
fixed pylint warnings
996d02e
@dangunter
fixed pylint warnings
a1fce65
@dangunter
minor rename
9a6ede5
@CopyDemon
add _load_module function now module arg can support python module na…
f849862 
…me, and path to .py file
@CopyDemon
update import path from relative path to module import
a9bc66b
@CopyDemon
format with black
bf5f53e
@dangunter
hey
30561b7
@dangunter
identify code by either name/label or caption
0d7af99
@dangunter
before/after fix
ee6f5cb
@dangunter
test for runner changes
43e6682
@dangunter
Merge remote-tracking branch 'upstream/main' into structured_flowsheet
3c280b6
@dangunter
Merge remote-tracking branch 'origin/structured_flowsheet' into struc…
d1bd160 
…tured_flowsheet
@dangunter
move error check
3951967
@dangunter
safeguards for missing solver
fb17e5b
@dangunter
fix pandoc install cmd
60312c4
@CopyDemon
Fix runner_cli to support relative file paths and same-directory imports
e1e79c7
@CopyDemon
format with black
b4ca4e6
@dangunter
added --info flag to get information without running
3f0a36a
@dangunter
whitespace
bccf255
@dangunter
Merge branch 'structured_flowsheet' of github.com:dangunter/idaes-pse…
d6f1d0f 
… into structured_flowsheet
@dangunter
fixed logic for module, added info
a63f80f
@ksbeattie
Copy link
Member

ksbeattie commented Feb 5, 2026

@dangunter, do you think this will make the Feb (this month) release?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@agarciadiego agarciadiego Awaiting requested review from agarciadiego agarciadiego is a code owner

@dallan-keylogic dallan-keylogic Awaiting requested review from dallan-keylogic dallan-keylogic is a code owner

@CopyDemon CopyDemon Awaiting requested review from CopyDemon

@bpaul4 bpaul4 Awaiting requested review from bpaul4 bpaul4 is a code owner

@sufikaur sufikaur Awaiting requested review from sufikaur sufikaur is a code owner

@ksbeattie ksbeattie Awaiting requested review from ksbeattie ksbeattie is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees

@dangunter dangunter

Labels

enhancement New feature or request Priority:Normal Normal Priority Issue or PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Flowsheet building/running/introspection for Jupyter integration

3 participants

@dangunter @ksbeattie @CopyDemon